main

Assertion checks for unit tests.

FYI: Should not require any pytest functionality

Functions⚓︎

assert_against_cache ⚓︎

assert_against_cache(test_data, *, path_cache_dir, cache_name, assert_rules=None, metadata=None, always_write=None)

Core logic for pytest_cache_assert to handle caching and assertion-checking.

PARAMETER	DESCRIPTION
`test_data`	dictionary or list to test (could be from cache) TYPE: `Any`
`path_cache_dir`	location of the cache directory TYPE: `Path`
`cache_name`	relative string path from the test_dir to the JSON cache file TYPE: `str`
`assert_rules`	dictionary of AssertRules to apply when selectively ignoring differences TYPE: `Optional[List[AssertRule]]` DEFAULT: `None`
`metadata`	metadata dictionary to store in the cache file TYPE: `Optional[Dict]` DEFAULT: `None`
`always_write`	if True, always write the changes TYPE: `Optional[bool]` DEFAULT: `None`

Source code in pytest_cache_assert/main.py

@beartype
def assert_against_cache(
    test_data: Any,
    *,
    path_cache_dir: Path,
    cache_name: str,
    assert_rules: Optional[List[AssertRule]] = None,
    metadata: Optional[Dict] = None,  # type: ignore[type-arg]
    always_write: Optional[bool] = None,
) -> None:
    """Core logic for pytest_cache_assert to handle caching and assertion-checking.

    Args:
        test_data: dictionary or list to test (could be from cache)
        path_cache_dir: location of the cache directory
        cache_name: relative string path from the test_dir to the JSON cache file
        assert_rules: dictionary of AssertRules to apply when selectively ignoring differences
        metadata: metadata dictionary to store in the cache file
        always_write: if True, always write the changes

    """
    config = retrieve(CacheAssertContainerKeys.CONFIG)
    cache_store = config.cache_store
    path_cache_file = path_cache_dir / cache_name
    cache_store.initialize(path_cache_dir, config.converters)
    test_data = cache_store.serialize(test_data)
    # Function argument overrides global
    aw = config.always_write if always_write is None else always_write
    try:
        cached_data = read_from_cache(path_cache_dir=path_cache_dir, cache_name=cache_name)
    except NoCacheError:
        cached_data = test_data
    cache_store.write(path_cache_file, metadata=metadata, test_data=test_data, always_write=aw)

    validator = config.validator
    validator.assertion(
        cached_data=cached_data, test_data=test_data, assert_rules=assert_rules or [],
        path_cache_file=path_cache_file,
    )

assert_against_dict ⚓︎

assert_against_dict(old_dict, new_dict, assert_rules=None)

Utilize custom DictDiffer logic to compare in-memory dictionaries.

PARAMETER	DESCRIPTION
`old_dict`	old dictionary (typically cached one) TYPE: `Dict`
`new_dict`	new dictionary (typically test data) TYPE: `Dict`
`assert_rules`	dictionary of AssertRules to apply when selectively ignoring differences TYPE: `Optional[List[AssertRule]]` DEFAULT: `None`

Source code in pytest_cache_assert/main.py

@beartype
def assert_against_dict(
    old_dict: Dict,  # type: ignore[type-arg]
    new_dict: Dict,  # type: ignore[type-arg]
    assert_rules: Optional[List[AssertRule]] = None,
) -> None:
    """Utilize custom DictDiffer logic to compare in-memory dictionaries.

    Args:
        old_dict: old dictionary (typically cached one)
        new_dict: new dictionary (typically test data)
        assert_rules: dictionary of AssertRules to apply when selectively ignoring differences

    """
    config = retrieve(CacheAssertContainerKeys.CONFIG)
    cache_store = config.cache_store
    cache_store.initialize(None, config.converters)
    new_dict = cache_store.serialize(new_dict)

    validator = config.validator
    validator.assertion(cached_data=old_dict, test_data=new_dict, assert_rules=assert_rules or [])

read_from_cache ⚓︎

read_from_cache(*, path_cache_dir, cache_name)

Read from cache without writing.

PARAMETER	DESCRIPTION
`path_cache_dir`	location of the cache directory TYPE: `Path`
`cache_name`	relative string path from the test_dir to the JSON cache file TYPE: `str`

RETURNS	DESCRIPTION
`Dict`	cached data TYPE: `Any`

Source code in pytest_cache_assert/main.py

@beartype
def read_from_cache(*, path_cache_dir: Path, cache_name: str) -> Any:
    """Read from cache without writing.

    Args:
        path_cache_dir: location of the cache directory
        cache_name: relative string path from the test_dir to the JSON cache file

    Returns:
        Dict: cached data

    """
    config = retrieve(CacheAssertContainerKeys.CONFIG)
    cache_store = config.cache_store
    path_cache_file = path_cache_dir / cache_name
    return cache_store.read_cached_data(path_cache_file)

Last update: August 30, 2023
Created: August 30, 2023